Lookerで開発環境➟本番環境にコンテンツをデプロイするときの方法と使い分け方をまとめてみる #looker

「カスタマーストーリー」を支えるツール特集

さがら

2021.02.28

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

さがらです。

Lookerでインスタンスを2つ用意して、開発環境・本番環境と2つの用途で分けて使用している場合、必ず「開発環境➟本番環境へのデプロイ」ということが必要になってきます。

「LookerはLookMLでコード管理しているからリポジトリ連携すれば終わりでしょ」と思われる方もいるかもしれませんが、そんなことはありません。

この理由と、どういったデプロイ方法がありそれぞれどんなメリット・デメリットがあるのか、をこのブログでまとめていきます。

開発➟本番へのデプロイが一筋縄でいかない理由

さて、改めてLookerでの開発環境➟本番環境へのデプロイが一筋縄ではいかない理由を考えてみます。

それは、Lookやダッシュボードなどの”コンテンツ”は、コードで定義されていないためです。具体的には下図のような状況に陥るかと思います。（わかりやすくするため諸々省略しています。）

LookMLで定義したModelやViewは、WebhookやDeployment Managerを介して本番環境へのデプロイも難なく行えるかと思います。

しかしLookやDashboardなどのコンテンツはどうでしょうか、コード化されていないためGithubを介すことも出来ませんし、ファイルのようにコピー&ペーストで別のインスタンスへ複製することも出来ません。

そのため、LookやDashboardをどうやって本番環境にデプロイするかが、ポイントになってきます。こちらについて方法が大きく２種類ありますので、次の章で説明します。

まず1つ目の方法が、LookML Dashboardに変換して、ダッシュボードもコード化してしまう方法です。

具体的には下図のように、開発環境のインスタンスにおいてダッシュボードをGUIで作成した後LookML Dashboardに変換してコード化し、WebhookやDeployment Managerを用いて本番環境へデプロイする、という流れになります。

この方法については、具体的な手順は下記のブログにまとめております。

2つ目の方法が、Looker Deployer等OSSのツールを使用して、特にコンテンツを変換することなく、そのまま本番環境にデプロイする方法です。

具体的には下図のように、デプロイのタイミングでOSSのツールでコマンドを実行し、本番環境にダッシュボード等のコンテンツをデプロイする、という流れになります。

この方法について、OSSのCLIツールの1つであるLooker Deployerを用いた実際の手順を下記のブログにまとめております。

続いて、これら2つの方法にどういったメリット・デメリットがあるのかをまとめます。

URLに記載されるダッシュボードIDが開発環境と本番環境で同じ値にすることが出来る
- Linkパラメータを用いたダッシュボード間のリンクをしたいときに便利。
全てGitでの管理ができるため、これまでの履歴の確認が出来る
- データモデルだけでなくダッシュボードも履歴管理できるようになるため、万が一ダッシュボードの削除等の問題があっても簡単に復元できる。

ダッシュボード修正時のプロセスが少し手間がかかる
- LookML Dashboardのままでの修正はとても難しいため、開発環境のダッシュボードを一度User-Defined Dashboardに直してから修正し、再度LookML Dashboardに変換し、本番環境にデプロイしないといけない場合が多い。
1つのフォルダに集約されてしまい、フォルダの階層構造も作れない
- LookML Dashboardは全て「All folders➟LookML Dashboards」というフォルダに格納されてしまう。Whitelabelを用いたOEMでの外部への提供などを考えた時、全てのダッシュボードが1つのフォルダにまとまっていると使いづらくなる可能性がある。

LookML Dashboardよりも修正時の対応が簡単
- GUIで定義したUser-Defined Dashboardのままデプロイが出来るため、ダッシュボードに少し修正が必要となってもGUI上で直してすぐにデプロイが可能。
任意のタイミングでのデプロイが可能
- Webhookを使ったデプロイだとPushを通知したとき等にタイミングが限られてしまうが、OSSを用いた場合、コマンドを実行した時にデプロイが行われるので、デプロイ実行タイミングの自由度が高い。

ダッシュボードのIDが開発環境と本番環境と異なってしまうため、ダッシュボード間のLinkパラメータが機能しなくなってしまう
- ダッシュボード間のリンクを行いたい場合は、LookML Dashboardを使うしかない。
トラブル発生時にLookerの公式サポートが使えない
- Looker DeployerなどのOSSツールはLookerの公式サポート対象外であり、上手く動かない等のトラブルがあったときはOSSのリポジトリにissue発行で対応してもらうしかない。